home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_xemacs.idb / usr / freeware / lib / xemacs-20.4 / lisp / README.z / README
Encoding:
Text File  |  1998-05-21  |  5.3 KB  |  168 lines
  1.  
  2. The subdirectories of this directory contain source code for the XEmacs
  3. facilities written in Emacs Lisp.  *.el files are Elisp source, and *.elc
  4. files are byte-compiled versions of the corresponding *.el files.
  5. Byte-compiled files are architecture-independent.
  6.  
  7. When XEmacs starts up, it adds all subdirectories of the site-lisp
  8. directory.  The site-lisp directory normally exists only in
  9. installation trees.  For more information about the site-lisp
  10. directory see the NEWS file.
  11.  
  12. After XEmacs adds all subdirectories of the site-lisp directory, it
  13. adds all subdirectories of this directory to the load-path (the list
  14. of directories to be searched when loading files.)  To speed up this
  15. process, this directory has been rearranged to have very few files at
  16. the top-level, so that emacs doesn't have to stat() several hundred
  17. files to find the dozen or so which are actually subdirectories.
  18.  
  19. Directories whose names begin with "-" or "." are not added to the default
  20. load-path.
  21.  
  22. The only files which remain at top-level are those which you might
  23. reasonably want to alter when installing or customizing XEmacs at your
  24. site.  The files which may appear at top level are:
  25.  
  26.     paths.el    You may need to change the default pathnames here,
  27.             but probably not.  This is loaded before XEmacs is
  28.             dumped.
  29.  
  30.     site-init.el    To pre-load additional libraries into XEmacs and dump
  31.             them in the executable, load them from this file.
  32.             Read the instructions in this file for a description
  33.             of how to do this.
  34.  
  35.     site-load.el    This is like site-init.el, but if you want the 
  36.             docstrings of your preloaded libraries to be kept in
  37.             the DOC file instead of in the executable, you should
  38.             load them from this file instead.  To do this, you must
  39.             also cause them to be scanned when the DOC file is
  40.             generated by editing ../src/Makefile.in.in and
  41.             rerunning configure.
  42.  
  43.     site-start.el    This is loaded each time XEmacs starts up, before the
  44.             user's .emacs file.
  45.  
  46.     default.el    This is loaded each time XEmacs starts up, after the
  47.             user's .emacs file, unless .emacs sets the variable
  48.             inhibit-default-init to t.
  49.  
  50.     version.el    This contains the version information for XEmacs.
  51.  
  52.  
  53. These are the main subdirectories:
  54.  
  55.     prim        Fundamental XEmacs functionality.  Some of this is
  56.             pre-dumped with XEmacs, some is autoloaded.
  57.  
  58.     utils        Various utility functions that some other XEmacs
  59.             packages build on.  These are not user commands.
  60.  
  61.     modes        Text-editing and programming-language-sensitive modes.
  62.  
  63.     emulators    XEmacs can emulate a few different editors.  These are
  64.             a bit more than what `modes' generally are.
  65.  
  66.     term        Terminal-specific customization files.  When XEmacs
  67.             starts, it checks the $TERM environment variable to
  68.             see what type of terminal the user is running on, and
  69.             loads a file named $TERM.el from this directory, if
  70.             that file exists.
  71.  
  72.     x11        X Window System-specific code.
  73.  
  74.     games        Various fun sorts of things.
  75.  
  76.     packages    Random other utilities that are not primarily about
  77.             editing text.  For example, code for automatically
  78.             uncompressing .Z files would be here.  This is an
  79.             `everything else' sort of directory.
  80.  
  81. Some packages are fairly large; those have been given their own    directories:
  82.  
  83.     auctex        A package for editing TeX documents.
  84.  
  85.     bytecomp    The XEmacs-lisp compiler.
  86.  
  87.     calendar    A calendar and appointment manager.
  88.  
  89.     cl        Common Lisp compatibility code.
  90.  
  91.     comint        General code for interacting with inferior processes,
  92.             like shell buffers and lisp interpreters.
  93.  
  94.     custom        User environment customization code.
  95.  
  96.     edebug        A source-level debugger for Elisp.
  97.  
  98.     ediff        A comprehensive visual interface to diff and patch.
  99.  
  100.     efs        The directory editor, remote FTP frontend.
  101.  
  102.     egg        MULE Input Method.
  103.  
  104.     electric    The "electric" commands; these implement temporary
  105.             windows for help, list-buffers, etc.
  106.  
  107.     eos        An interface to Sun's SparcWorks product.
  108.  
  109.     eterm        A merge of the comint shell mode with an
  110.             ANSI-compatible terminal-emulator.
  111.  
  112.     gnats        Interface to XEmacs bug reporting system based on
  113.             Cygnus GNATS.
  114.  
  115.     gnus        A network news and mail reader.
  116.  
  117.     hm--html-menus    Menu interface to html-mode.
  118.  
  119.     ilisp        A comint-based package for interacting with inferior
  120.             lisp processes.
  121.  
  122.     iso        ISO Latin language support.
  123.  
  124.     its        MULE Input Method.  [Requires installing LEIM at
  125.             XEmacs build]
  126.  
  127.     language    MULE non-English language support.  [Requires
  128.             installing LEIM at XEmacs build]
  129.  
  130.     locale        IE18N stuff.
  131.  
  132.     mailcrypt    Package for dealing with PGP encrypted messages.
  133.  
  134.     mel        MIME encoding library (part of the Tools for MIME).
  135.  
  136.     mh-e        An interface to the MH-E mail handling system.
  137.  
  138.     mu        Message Utilities library (part of the Tools for
  139.             MIME).
  140.  
  141.     mule        Multi-lingual extensions for XEmacs.  [Requires
  142.             installing LEIM at XEmacs build]
  143.  
  144.     pcl-cvs        An interface to the Concurrent Version System.
  145.  
  146.     psgml        General purpose SGML editing support with extra
  147.             support for editing HTML.
  148.  
  149.     quail        MULE Input Method.  [Requires installing LEIM at
  150.             XEmacs build]
  151.  
  152.     rmail        A BABYL-format mail reader.
  153.  
  154.     sunpro        Additional code for interfacing with SunPro products.
  155.  
  156.     tl        Tiny Library (Part of the Tools for MIME).
  157.  
  158.     tm        Tools for MIME.  MIME support for emacs lisp based
  159.             news and mail readers.
  160.  
  161.     tooltalk    An inteface to the ToolTalk communication protocol.
  162.  
  163.     viper        A full-featured VI emulator.
  164.  
  165.     vm        View Mail, an UNIX-format alternative to RMAIL.
  166.  
  167.     w3        A World Wide Web interface.
  168.